Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates documentation (Improves #114) #117

Conversation

prasadtalasila
Copy link
Contributor

  • Adds developer documentation
  • Updates user documentation
  • Uses mermaid to integrate UML diagrams
    into the documentation.
  • Uses npm madge to generate dependency graphs
    for source code.
  • Corrects the markdown linter configuration to
    catch the warnings in markdown files.

Copy link

@codeclimate codeclimate bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR diff size of 6351 lines exceeds the maximum allowed for the inline comments feature.

@codeclimate
Copy link

codeclimate bot commented Sep 29, 2023

Code Climate has analyzed commit 5d5980d and detected 562 issues on this pull request.

Here's the issue category breakdown:

Category Count
Style 562

View more on Code Climate.

@codecov-commenter
Copy link

codecov-commenter commented Sep 29, 2023

Codecov Report

Merging #117 (5d5980d) into feature/distributed-demo (6e6b9f5) will increase coverage by 0.86%.
The diff coverage is n/a.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

@@                     Coverage Diff                      @@
##           feature/distributed-demo     #117      +/-   ##
============================================================
+ Coverage                     65.80%   66.66%   +0.86%     
============================================================
  Files                            35       42       +7     
  Lines                           424      537     +113     
  Branches                         27       31       +4     
============================================================
+ Hits                            279      358      +79     
- Misses                          129      160      +31     
- Partials                         16       19       +3     

see 7 files with indirect coverage changes

Components Coverage Δ
Website 62.72% <ø> (ø)
Lib Microservice 69.91% <ø> (∅)

@prasadtalasila prasadtalasila merged commit 3e1935e into INTO-CPS-Association:feature/distributed-demo Sep 29, 2023
4 checks passed
@prasadtalasila prasadtalasila deleted the pr-114 branch September 29, 2023 12:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants